📦 EqualifyEverything / equalify-docs

📄 3.2: Audit Report Detailed View.md · 40 lines
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40This page is intended for **Developers and Accessibility Specialists** tasked with fixing specific code-level issues. Switch to the Audit Report detailed view for the "under-the-hood" companion to your summary view. While the summary tells you how many problems you have, this view tells a developer exactly where they are and how to fix them.
## Filtering & Search: 
- **Issue Tabs:** You can toggle between **Active** issues (currently live on the site), **Ignored** issues (manually hidden), and **All** recorded issues.
- Use the **Filter by Tags** or **Categories** dropdowns to group issues by type (e.g., contrast, images, or ARIA roles). You can also search for a specific page using the Search by URL field.
```tip
💡Tip: Use the tags to check if your content meets your WCAG compliance level. Equalify uses AxeCore for web and Vera for PDF rulesets - see those for full details. Below are the main tags to know:
Web Tags:
- “wcag2aa” = all WCAG 2.0 A & AA issues found
- “wcag21aa” = all WCAG 2.1 A & AA issues found
- “wcag22aa” = all WCAG 2.2 A & AA issues found 
PDF Tags:
- Any PDF issues found are logged under PDF UA standards and should be considered for remediation.
```
- **Asset type toggles:** Quickly switch between issues found in HTML (web) versus those found within PDF documents.<br>
- **Show/hide columns:** Tailor the view to show or hide audit details.<br>
- **Download the report** as a CSV file, which is helpful for teams that want to manage issues in issue-tracking software (e.g., JIRA, Rally).<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/46ed941ba70a82efbf5bddc737451c34a90fff83/user/User%20Guide%20Images/Sec%203_Audit%20Detail%20View%20Filtering%20and%20Search.png" alt="Audit Report Detailed View header with Active/ Ignored / All tabs, and All / HTML / PDF filter buttons, Filter by Tags, Filter by Categories, and Search by URL field." width="500"/><br>
## Detailed Issue List
This central table lists every accessibility violation, including the specific URL where it occurred and a plain-English explanation of the WCAG (Web Content Accessibility Guidelines) rule violated.
Important Details for Developers: To move from identifying a problem to fixing it, focus on these three technical components provided in each row:
- **Issue:** High-level description of what the problem is, and what category it falls under.
- **The Issue Identifier:** Each error is assigned a unique code (e.g., UWQ330 or WKN817). These serve as reference points for tracking fixes across different scans. You can open the issue or copy its link.
- **Issue Detail page:** When you click on the issue identifier, Equalify provides a deep dive into the issue to help you resolve it quickly.
    - **Appears on:** What page or PDF does this blocker appear on.
    - **Audit:** What audit did this arise from.
    - **Error:** High-level description of what the issue is.
    - **Category:** What categories does this blocker fall under.
    - **Tags:** What tags does this blocker fall under.
    - **Code Snippet:** Equalify extracts the exact HTML block causing the flag.
```important
⚠️Important: For PDFs: Equalify can not point you to the specific page where an issue occurs, as it cannot identify the exact snippet.
```
- **Code**
    - **View Code button:** Clicking View Code opens a snippet of the page's source code, highlighting the exact line to modify.
    - **Issue Element:** This identifies the specific HTML element affected by the issue.
- **Category:** What categories does this blocker fall under.
- **Tags:** What tags does this blocker fall under.
- **Ignore:** Toggle an issue on/off for the report.<br>
<img src="https://github.com/EqualifyEverything/equalify-docs/blob/46ed941ba70a82efbf5bddc737451c34a90fff83/user/User%20Guide%20Images/Sec%203_Dashboard%20Audit%20Report%20Detailed%20View.png" alt="Detailed audit results table listing Type, URL, Issue, and Code columns with View Code buttons for each issue." width="500"/>